Places a volume offline. Most applications don’t need to do this.

OSErr PBOffLine (
    ParmBlkPtr paramBlock
);

paramBlock

A pointer to a basic File Manager parameter block.

function result

A result code.

DISCUSSION

The relevant fields of the parameter block are:

• ioCompletion

  On input, a pointer to a completion function.

• ioResult

  On output, the result code of the function.

• ioNamePtr

  On input, a pointer to a pathname.

• ioVRefNum

  On input, a volume specfication.

The PBOffLine function places the specified volume offline by calling PBFlushVolSync or PBFlushVolAsync to flush the volume and releasing all the memory used for the volume except for the volume control block.

The PBOffLine function always executes synchronously.

AVAILABILITY

Supported in Carbon. Not available in Carbon.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)